SftTree/OCX 7.0

SftTreeItems.Expand Method

Softel vdm, Inc.

Expands all items so their dependents become visible.

Syntax       

VB.NET

object.Expand(ByVal Preserve As Boolean, ByVal Depth As Boolean)

VB

object.Expand(ByVal Preserve As Boolean, ByVal Depth As Boolean)

C#.NET

void object.Expand(bool Preserve, bool Depth);

VC++

HRESULT object->Expand(VARIANT_BOOL Preserve, VARIANT_BOOL Depth);

C

HRESULT object->raw_Expand(VARIANT_BOOL Preserve, VARIANT_BOOL Depth);

Delphi

procedure object.Expand(Preserve : WordBool, Depth : WordBool);

object

A SftTreeItems object.

Preserve

Defines whether the expand/collapse state is restored.  This argument is ignored if the Depth argument is True.

Preserve

Description

True

Restores the expand/collapse state of dependent items made visible, as saved by a previous call to Items.Collapse or Item.Collapse.

False

The expand/collapse state is not restored.  All items are expanded and immediate dependents are made visible.  They may be expanded or collapsed based on the Depth argument.

Depth

Defines the depth of the items to become visible.

Depth

Description

True

Expands all dependent items, including non-immediate dependent items.  Preserve is ignored as all dependents are expanded.

False

Expands dependent items, based on the Preserve settings.

Comments

The Expand method expands all items so their dependents become visible.

The Expand method expands all items and restores the expand/collapse state of all dependent items, as saved by a previous Items.Collapse or Item.Collapse method call. The Expand method visits each item on level 0 and expands these based on the Preserve and Depth arguments.

If items are already expanded when using Expand, the items remains unchanged.  It does not make any indirect dependents visible.  To make sure that an item's indirect dependents are shown, use the Items.Collapse method first, which collapses all items (and all dependents), followed by Expand.  Now all dependents are visible.

See Also  SftTreeItems Object | Object Hierarchy


Feedback / comments / error reports for this topic
© 2015 - Softel vdm, Inc. - www.softelvdm.com